extends layout

block content
    script(src='/javascripts/ace/ace.js' type='text/javascript')
    script(src='/javascripts/ace/ext-themelist.js' type='text/javascript')
    script(src='/javascripts/document.js' type='text/javascript')
    .container
        .row.well.well-lg
            .panel.panel-primary
                .panel-heading
                    h3.panel-title 词汇查询系统API文档
                .panel-body
                    .list-group
                        .list-group-item.redirect-hash(data-target='server')
                            .row-action-primary
                                i.material-icons language
                            .row-content
                                h4.list-group-item-heading 服务器接口
                                p.list-group-item-text 搭建Web服务器, 通过HTTP请求获取查询结果，数据库可配置Mongodb或sqlite
                        .list-group-separator
                        .list-group-item.redirect-hash(data-target='client')
                            .row-action-primary
                                i.material-icons work
                            .row-content
                                h4.list-group-item-heading 客户端接口
                                p.list-group-item-text 引入dll文件, 在项目中调用C#接口获取查询接口，数据库为sqlite
                        .list-group-separator

        #server.row.well.well-lg
            .panel.panel-primary
                .panel-heading
                    h3.panel-title 服务器接口
                .panel-body
                    .col-sm-12
                        h4.text-info 词汇获取接口
                        .col-sm-6
                            h4.text-info 请求格式
                            .col-sm-12
                                p.text-primary 请求方法:
                                    span.text-warning &nbsp;&nbsp;GET/POST
                                p.text-primary 请求URL:
                                    span.text-warning &nbsp;&nbsp;/search,
                                p.text-primary 请求参数:
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;word:
                                    span.text-info &nbsp;&nbsp;要查询的单词
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;segment:
                                    span.text-info &nbsp;&nbsp;要查询的片段
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;scales:
                                    span.text-info &nbsp;&nbsp;要查询的所属范围, 逗号分隔, 取值0,1,2,3的组合, <br>&nbsp;&nbsp;
                                        | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
                                        | 分别代表未定义, 小学, 初中, 高中的单词. <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
                                        | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;如查询小学和初中的单词
                                        | , scales为"1,2"
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;pageIndex:
                                    span.text-info &nbsp;&nbsp;页码,取大于等于1的整数
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;pageSize:
                                    span.text-info &nbsp;&nbsp;页面单词数, 取大于等于1的整数
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;type:
                                    span.text-info &nbsp;&nbsp;取detail|phonetic|explains|scale其中之一, 默认detail<br>
                        .col-sm-6
                            h4.text-info 响应格式
                            .col-sm-12
                                p.text-primary 响应类型:
                                    span.text-warning &nbsp;&nbsp;application/json<br>
                                p.text-primary 响应数据结构:
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;errCode:
                                    span.text-info &nbsp;&nbsp;错误码, 无错误为0, 有错误为1
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;errMsg:
                                    span.text-info &nbsp;&nbsp;错误信息, 无错误时不存在此属性
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;result:
                                    span.text-info &nbsp;&nbsp;调用结果, 有错误时不存在此属性, 无错误时是一个数组
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;result.word:
                                    span.text-info &nbsp;&nbsp;单词拼写
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;result.phonetic:
                                    span.text-info &nbsp;&nbsp;音标, 包括default/usPhonetic/ukPhonetic3个属性
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;result.outline:
                                    span.text-info &nbsp;&nbsp;概要解释
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;result.meanings:
                                    span.text-info &nbsp;&nbsp;释义
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;result.properties:
                                    span.text-info &nbsp;&nbsp;词性
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;result.explains:
                                    span.text-info &nbsp;&nbsp;带词性的详细解释, 类型为数组
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;result.scale:
                                    span.text-info &nbsp;&nbsp;所属范围, 0,1,2,3分别表示:未定义/小学/初中/高中

                        .col-sm-12
                            h4.text-info 实例
                            .col-sm-6
                                .col-sm-12.well#editorReq1
                            .col-sm-6
                                .col-sm-12.well#editorRes1
                    .col-sm-12
                        h4.text-info 文本音标标注接口
                        .col-sm-6
                            h4.text-info 请求格式
                            .col-sm-12
                                p.text-primary 请求方法:
                                    span.text-warning &nbsp;&nbsp;GET/POST
                                p.text-primary 请求URL:
                                    span.text-warning &nbsp;&nbsp;/phonetic,
                                p.text-primary 请求参数:
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;text:
                                    span.text-info &nbsp;&nbsp;需要标注音标的文本
                        .col-sm-6
                            h4.text-info 响应格式
                            .col-sm-12
                                p.text-primary 响应类型:
                                    span.text-warning &nbsp;&nbsp;application/json<br>
                                p.text-primary 响应数据结构:
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;errCode/errMsg/result:
                                    span.text-info &nbsp;&nbsp;含义同查询接口
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;result.index:
                                    span.text-info &nbsp;&nbsp;单词在文本中的位置
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;result.size:
                                    span.text-info &nbsp;&nbsp;单词长度
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;result.phonetic:
                                    span.text-info &nbsp;&nbsp;音标, 包含default/usPhonetic/ukPhonetic属性
                        .col-sm-12
                            h4.text-info 实例
                            .col-sm-6
                                .col-sm-12.well#editorReq2
                            .col-sm-6
                                .col-sm-12.well#editorRes2
                    .col-sm-12
                        h4.text-info 过滤超纲词接口
                        .col-sm-6
                            h4.text-info 请求格式
                            .col-sm-12
                                p.text-primary 请求方法:
                                    span.text-warning &nbsp;&nbsp;GET/POST
                                p.text-primary 请求URL:
                                    span.text-warning &nbsp;&nbsp;/phonetic,
                                p.text-primary 请求参数:
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;text:
                                    span.text-info &nbsp;&nbsp;需要标注音标的文本
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;scale:
                                    span.text-info &nbsp;&nbsp;大纲范围, 取值为1,2,3其一,过滤小学/初中/高中范围内单词<br>
                                    span.text-danger &nbsp;&nbsp;&nbsp;&nbsp;注: 较高大纲查询会包含较低的. <br>&nbsp;&nbsp;
                                        | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;如: 查询是否超过高中大纲时. 小学大纲内单词不会计入
                        .col-sm-6
                            h4.text-info 响应格式
                            .col-sm-12
                                p.text-primary 响应类型:
                                    span.text-warning &nbsp;&nbsp;application/json<br>
                                p.text-primary 响应数据结构:
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;errCode/errMsg:
                                    span.text-info &nbsp;&nbsp;含义同查询接口
                                p.text-warning &nbsp;&nbsp;&nbsp;&nbsp;outScale:
                                    span.text-info &nbsp;&nbsp;超纲词列表, 类型为字符串数组
                        .col-sm-12
                            h4.text-info 实例
                            .col-sm-6
                                .col-sm-12.well#editorReq3
                            .col-sm-6
                                .col-sm-12.well#editorRes3

        #client.row.well.well-lg
            .panel.panel-primary
                .panel-heading
                    h3.panel-title 客户端接口
                .panel-body
                    h4.text-info 初始化Sqlite词典
                    .col-sm-12
                        p.text-primary 1. 引入编译后的.dll文件或直接在将UTMP.Plugins.DictUtil项目引入工程中,
                        p.text-primary 2. 使用命名空间using UTMP.Plugins.DictUtil;
                        p.text-primary 3. 调用DictUtils.Init(@".db3文件的绝对路径")初始化词典数据;
                    h4.text-info 查询词汇接口
                    .col-sm-12
                        p.text-warning DictUtils.QueryWord("要查询的单词");
                            span.text-primary 查询单个单词的信息, 返回WordDetail对象实例
                        p.text-warning DictUtils.QueryWord("要查询的单词");
                            span.text-primary 查询单个单词, 直接返回JSON格式的字符串
                    h4.text-info 查询默认音标接口
                    .col-sm-12
                        p.text-warning DictUtils.QueryDefaultPhonetic("要查询的单词");
                            span.text-primary 查询单词的默认音标
                    h4.text-info 查询超纲词接口
                    .col-sm-12
                        p.text-warning DictUtils.FilterOutScale("英文文本", 大纲范围);
                            span.text-primary 查询文本中的超纲词, 0,1,2,3分别表示未定义/小学/初中/高中
